Inclinometer 4 Click Driver

API for configuring and manipulating Inclinometer 4 Click driver. More...

Topics
	Inclinometer 4 Registers List
	List of registers of Inclinometer 4 Click driver.
	Inclinometer 4 Registers Settings
	Settings for registers of Inclinometer 4 Click driver.
	Inclinometer 4 MikroBUS Map
	MikroBUS pin mapping of Inclinometer 4 Click driver.

Functions
void	inclinometer4_cfg_setup (inclinometer4_cfg_t *cfg)
	Inclinometer 4 configuration object setup function.
void	inclinometer4_drv_interface_sel (inclinometer4_cfg_t *cfg, inclinometer4_drv_t drv_sel)
	Inclinometer 4 driver interface setup function.
err_t	inclinometer4_init (inclinometer4_t *ctx, inclinometer4_cfg_t *cfg)
	Inclinometer 4 initialization function.
err_t	inclinometer4_default_cfg (inclinometer4_t *ctx)
	Inclinometer 4 default configuration function.
err_t	inclinometer4_write_regs (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Inclinometer 4 write regs function.
err_t	inclinometer4_read_regs (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	Inclinometer 4 read regs function.
err_t	inclinometer4_write_reg (inclinometer4_t *ctx, uint8_t reg, uint8_t data_in)
	Inclinometer 4 write reg function.
err_t	inclinometer4_read_reg (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out)
	Inclinometer 4 read reg function.
uint8_t	inclinometer4_get_int1_pin (inclinometer4_t *ctx)
	Inclinometer 4 get int1 pin function.
uint8_t	inclinometer4_get_int2_pin (inclinometer4_t *ctx)
	Inclinometer 4 get int2 pin function.
err_t	inclinometer4_check_comm (inclinometer4_t *ctx)
	Inclinometer 4 check comm function.
err_t	inclinometer4_get_status (inclinometer4_t *ctx, uint8_t *status)
	Inclinometer 4 get status function.
err_t	inclinometer4_sw_reset (inclinometer4_t *ctx)
	Inclinometer 4 sw reset function.
err_t	inclinometer4_set_mode (inclinometer4_t *ctx, uint8_t mode)
	Inclinometer 4 set mode function.
err_t	inclinometer4_set_fsr (inclinometer4_t *ctx, uint8_t fsr)
	Inclinometer 4 set fsr function.
err_t	inclinometer4_set_odr (inclinometer4_t *ctx, uint8_t odr)
	Inclinometer 4 set odr function.
err_t	inclinometer4_get_data (inclinometer4_t *ctx, inclinometer4_data_t *data_out)
	Inclinometer 4 get data function.

Detailed Description

API for configuring and manipulating Inclinometer 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

inclinometer4_cfg_setup()

void inclinometer4_cfg_setup

(

inclinometer4_cfg_t *

cfg

)

Inclinometer 4 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

inclinometer4_check_comm()

err_t inclinometer4_check_comm

(

inclinometer4_t *

ctx

)

Inclinometer 4 check comm function.

This function checks the communication by reading and verifying the device ID.

Parameters

[in]

ctx

: Click context object. See inclinometer4_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_default_cfg()

err_t inclinometer4_default_cfg

(

inclinometer4_t *

ctx

)

Inclinometer 4 default configuration function.

This function executes a default configuration of Inclinometer 4 Click board.

Parameters

[in]

ctx

: Click context object. See inclinometer4_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

inclinometer4_drv_interface_sel()

void inclinometer4_drv_interface_sel	(	inclinometer4_cfg_t *	cfg,
		inclinometer4_drv_t	drv_sel )

Inclinometer 4 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See inclinometer4_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

inclinometer4_get_data()

err_t inclinometer4_get_data	(	inclinometer4_t *	ctx,
		inclinometer4_data_t *	data_out )

Inclinometer 4 get data function.

This function reads accel X, Y, and Z axis data in g and temperature in degrees Celsius.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[out]	data_out	: X, Y, and Z axis data in g, and temperature in degrees Celsius. See inclinometer4_data_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_get_int1_pin()

uint8_t inclinometer4_get_int1_pin

(

inclinometer4_t *

ctx

)

Inclinometer 4 get int1 pin function.

This function returns the interrupt 1 (INT1) pin logic state.

Parameters

[in]

ctx

: Click context object. See inclinometer4_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

inclinometer4_get_int2_pin()

uint8_t inclinometer4_get_int2_pin

(

inclinometer4_t *

ctx

)

Inclinometer 4 get int2 pin function.

This function returns the interrupt 2 (INT2) pin logic state.

Parameters

[in]

ctx

: Click context object. See inclinometer4_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

inclinometer4_get_status()

err_t inclinometer4_get_status	(	inclinometer4_t *	ctx,
		uint8_t *	status )

Inclinometer 4 get status function.

This function reads the interrupt status register.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[out]	status	: Interrupt status read.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_init()

err_t inclinometer4_init	(	inclinometer4_t *	ctx,
		inclinometer4_cfg_t *	cfg )

Inclinometer 4 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_read_reg()

err_t inclinometer4_read_reg	(	inclinometer4_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Inclinometer 4 read reg function.

This function reads a data byte from the selected register.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_read_regs()

err_t inclinometer4_read_regs	(	inclinometer4_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Inclinometer 4 read regs function.

This function reads a desired number of data bytes starting from the selected register.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_set_fsr()

err_t inclinometer4_set_fsr	(	inclinometer4_t *	ctx,
		uint8_t	fsr )

Inclinometer 4 set fsr function.

This function sets the accel measurement full scale range.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	fsr	: 0 - 2G, 1 - 4G, 2 - 8G, 3 - 16G.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_set_mode()

err_t inclinometer4_set_mode	(	inclinometer4_t *	ctx,
		uint8_t	mode )

Inclinometer 4 set mode function.

This function sets the device operating mode to standby or active.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	mode	: Operating mode: 0 - Standby, 1 - Active.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_set_odr()

err_t inclinometer4_set_odr	(	inclinometer4_t *	ctx,
		uint8_t	odr )

Inclinometer 4 set odr function.

This function sets the measurement output data rate.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	odr	: 0 - 3200Hz, 1 - 1600Hz, 2 - 800Hz, 3 - 400Hz, 4 - 200Hz, 5 - 100Hz, 6 - 50Hz, 7 - 25Hz, 8 - 12.5Hz, 9 - 6.25Hz, 10 - 3.125Hz, 11 - 1.563Hz, 12 - 0.781Hz,

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_sw_reset()

err_t inclinometer4_sw_reset

(

inclinometer4_t *

ctx

)

Inclinometer 4 sw reset function.

This function performs the device software reset.

Parameters

[in]

ctx

: Click context object. See inclinometer4_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_write_reg()

err_t inclinometer4_write_reg	(	inclinometer4_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Inclinometer 4 write reg function.

This function write a data byte to the selected register.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

inclinometer4_write_regs()

err_t inclinometer4_write_regs	(	inclinometer4_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Inclinometer 4 write regs function.

This function writes a desired number of data bytes starting from the selected register.

Parameters

[in]	ctx	: Click context object. See inclinometer4_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.